<html>
  <head>
    <title>ITableRequest</title>
    <link rel='stylesheet' type='text/css' href='../../../../stylesheet.css' title='Style' />
  </head>
  <body>
    <table border='0' width='100%' cellpadding='1' cellspacing='0' summary=''>
      <tr>
        <td colspan='2' bgcolor='#EEEEFF' class='NavBarCell1'>
          <table border='0' cellpadding='0' cellspacing='3' summary=''>
            <tr align='center' valign='top'>
              <td bgcolor='#EEEEFF' class='NavBarCell1'>
                <a href='../../../../overview-summary.html'>
                  <font class='NavBarFont1'>
                    <b>Overview</b>
                  </font>
                </a>&nbsp;
              </td>
              <td bgcolor='#EEEEFF' class='NavBarCell1'>
                <a href='package-summary.html'>
                  <font class='NavBarFont1'>
                    <b>Package</b>
                  </font>
                </a>&nbsp;
              </td>
              <td bgcolor='#FFFFFF' class='NavBarCell1Rev'>
                <font class='NavBarFont1Rev'>
                  <b>Unit</b>
                </font>&nbsp;
              </td>
            </tr>
          </table>
        </td>
      </tr>
    </table>
    <hr />
    <h2>
      <font size='-1'>OpenEdge\CommonInfrastructure\Common\ServiceMessage</font>
      <br />INTERFACE ITableRequest
    </h2>
    <p>INTERFACE OpenEdge.CommonInfrastructure.Common.ServiceMessage.ITableRequest </p>
    <dl>
      <dd>
        <dl><!-- --></dl>
      </dd>
    </dl>
    <hr />
				<A NAME="property_summary"><!-- --></A>
				<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
				<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
				<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
				<B>Property Summary</B></FONT></TH>
				</TR>
				
    <tr bgcolor='white' class='TableRowColor'>
      <td align='right' valign='top' width='1%'>
        <font size='-1'>
          <code><a href="../../../../OpenEdge/Lang/FillModeEnum.cls.html" title="OpenEdge.Lang.FillModeEnum" target="classFrame">FillModeEnum</a></code>
        </font>
      </td>
      <td>
        <code>
          <b>
            <a href='#property.FillMode'>FillMode</a>
          </b> PROPERTY GET SET 
        </code><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The default FillMode for this request.
      </td>
    </tr>
    <tr bgcolor='white' class='TableRowColor'>
      <td align='right' valign='top' width='1%'>
        <font size='-1'>
          <code>LOGICAL</code>
        </font>
      </td>
      <td>
        <code>
          <b>
            <a href='#property.FullPage'>FullPage</a>
          </b> PROPERTY GET SET 
        </code><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieve full page when page position is at beginning or end of result-set
      </td>
    </tr>
    <tr bgcolor='white' class='TableRowColor'>
      <td align='right' valign='top' width='1%'>
        <font size='-1'>
          <code>INTEGER</code>
        </font>
      </td>
      <td>
        <code>
          <b>
            <a href='#property.NumRemainingPages'>NumRemainingPages</a>
          </b> PUBLIC GET SET 
        </code><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of remaining pages to retrieve. If this is zero, then
      </td>
    </tr>
    <tr bgcolor='white' class='TableRowColor'>
      <td align='right' valign='top' width='1%'>
        <font size='-1'>
          <code>CHARACTER</code>
        </font>
      </td>
      <td>
        <code>
          <b>
            <a href='#property.PageContext'>PageContext</a>
          </b> PROPERTY GET SET 
        </code><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;context info/key for where to start appending page begin or end
      </td>
    </tr>
    <tr bgcolor='white' class='TableRowColor'>
      <td align='right' valign='top' width='1%'>
        <font size='-1'>
          <code>INTEGER</code>
        </font>
      </td>
      <td>
        <code>
          <b>
            <a href='#property.PageSize'>PageSize</a>
          </b> PROPERTY GET SET 
        </code><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of records to return per page or batch
      </td>
    </tr>
    <tr bgcolor='white' class='TableRowColor'>
      <td align='right' valign='top' width='1%'>
        <font size='-1'>
          <code>CHARACTER</code>
        </font>
      </td>
      <td>
        <code>
          <b>
            <a href='#property.RowKey'>RowKey</a>
          </b> PROPERTY GET SET 
        </code><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return page positioned to this key (i.e. resort request/ reopen )
      </td>
    </tr>
    <tr bgcolor='white' class='TableRowColor'>
      <td align='right' valign='top' width='1%'>
        <font size='-1'>
          <code>CHARACTER</code>
        </font>
      </td>
      <td>
        <code>
          <b>
            <a href='#property.TableName'>TableName</a>
          </b> PROPERTY GET 
        </code><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;protected set - not changeable - provide with constructor
      </td>
    </tr>
    <tr bgcolor='white' class='TableRowColor'>
      <td align='right' valign='top' width='1%'>
        <font size='-1'>
          <code><a href="../../../../OpenEdge/CommonInfrastructure/Common/ServiceMessage/TableRequestTypeEnum.cls.html" title="OpenEdge.CommonInfrastructure.Common.ServiceMessage.TableRequestTypeEnum" target="classFrame">TableRequestTypeEnum</a></code>
        </font>
      </td>
      <td>
        <code>
          <b>
            <a href='#property.TableRequestType'>TableRequestType</a>
          </b> PROPERTY GET SET 
        </code><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
      </td>
    </tr>
				</TABLE>&nbsp;<P>
				
				<A NAME="method_summary"><!-- --></A>
				<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
				<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
				<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
				<B>Method Summary</B></FONT></TH>
				</TR>
				
    <tr bgcolor='white' class='TableRowColor'>
      <td align='right' valign='top' width='1%'>
        <font size='-1'>
          <code>VOID</code>
        </font>
      </td>
      <td>
        <code>
          <b>
            <a href='#addsearch(character,character,openedge.lang.operatorenum,openedge.lang.string,openedge.lang.datatypeenum,openedge.lang.joinenum)'> AddSearch</a>
          </b>(CHARACTER pcBufferName, CHARACTER pcFieldName, <a href="../../../../OpenEdge/Lang/OperatorEnum.cls.html" title="OpenEdge.Lang.OperatorEnum" target="classFrame">OperatorEnum</a> poOperator, <a href="../../../../OpenEdge/Lang/String.cls.html" title="OpenEdge.Lang.String" target="classFrame">String</a> poFieldValue, <a href="../../../../OpenEdge/Lang/DataTypeEnum.cls.html" title="OpenEdge.Lang.DataTypeEnum" target="classFrame">DataTypeEnum</a> poFieldType, <a href="../../../../OpenEdge/Lang/JoinEnum.cls.html" title="OpenEdge.Lang.JoinEnum" target="classFrame">JoinEnum</a> poJoinType)
        </code><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add search expression  (need to be kept separate from filter).
      </td>
    </tr>
    <tr bgcolor='white' class='TableRowColor'>
      <td align='right' valign='top' width='1%'>
        <font size='-1'>
          <code>LONGCHAR</code>
        </font>
      </td>
      <td>
        <code>
          <b>
            <a href='#buildsearchstring()'> BuildSearchString</a>
          </b>()
        </code><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns the search expression applied to the BuildQueryString
      </td>
    </tr>
    <tr bgcolor='white' class='TableRowColor'>
      <td align='right' valign='top' width='1%'>
        <font size='-1'>
          <code>VOID</code>
        </font>
      </td>
      <td>
        <code>
          <b>
            <a href='#getsearch(character,OUTPUT_character,OUTPUT_openedge.lang.operatorenum,OUTPUT_openedge.lang.string,OUTPUT_openedge.lang.datatypeenum,OUTPUT_openedge.lang.joinenum)'> GetSearch</a>
          </b>(CHARACTER pcBufferName, OUTPUT CHARACTER pcFieldName, OUTPUT <a href="../../../../OpenEdge/Lang/OperatorEnum.cls.html" title="OpenEdge.Lang.OperatorEnum" target="classFrame">OperatorEnum</a> poOperator, OUTPUT <a href="../../../../OpenEdge/Lang/String.cls.html" title="OpenEdge.Lang.String" target="classFrame">String</a> pcFieldValue, OUTPUT <a href="../../../../OpenEdge/Lang/DataTypeEnum.cls.html" title="OpenEdge.Lang.DataTypeEnum" target="classFrame">DataTypeEnum</a> poFieldType, OUTPUT <a href="../../../../OpenEdge/Lang/JoinEnum.cls.html" title="OpenEdge.Lang.JoinEnum" target="classFrame">JoinEnum</a> poJoinType)
        </code><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
      </td>
    </tr>
				</TABLE>&nbsp;<P>
				
				<A NAME="property_detail"><!-- --></A>
				<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
				<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
				<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
				<B>Property Detail</B></FONT></TH>
				</TR></TABLE>
				
    <a name='property.FillMode'><!-- --></a>
    <h3>FillMode</h3>
    <code><a href="../../../../OpenEdge/Lang/FillModeEnum.cls.html" title="OpenEdge.Lang.FillModeEnum" target="classFrame">FillModeEnum</a> PROPERTY GET SET </code>
    <dl>
      <dd>The default FillMode for this request. <p> </dd>
      <dd>
        <dl><!-- --></dl>
      </dd>
    </dl>
    <hr />
    <a name='property.FullPage'><!-- --></a>
    <h3>FullPage</h3>
    <code>LOGICAL PROPERTY GET SET </code>
    <dl>
      <dd>Retrieve full page when page position is at beginning or end of result-set <p> </dd>
      <dd>
        <dl><!-- --></dl>
      </dd>
    </dl>
    <hr />
    <a name='property.NumRemainingPages'><!-- --></a>
    <h3>NumRemainingPages</h3>
    <code>INTEGER PUBLIC GET SET </code>
    <dl>
      <dd>The number of remaining pages to retrieve. If this is zero, then <p> </dd>
      <dd>all data has been retrieved. This value is returned from the server/business component layer. </dd>
      <dd>
        <dl><!-- --></dl>
      </dd>
    </dl>
    <hr />
    <a name='property.PageContext'><!-- --></a>
    <h3>PageContext</h3>
    <code>CHARACTER PROPERTY GET SET </code>
    <dl>
      <dd>context info/key for where to start appending page begin or end <p> </dd>
      <dd>
        <dl><!-- --></dl>
      </dd>
    </dl>
    <hr />
    <a name='property.PageSize'><!-- --></a>
    <h3>PageSize</h3>
    <code>INTEGER PROPERTY GET SET </code>
    <dl>
      <dd>The number of records to return per page or batch <p> </dd>
      <dd>
        <dl><!-- --></dl>
      </dd>
    </dl>
    <hr />
    <a name='property.RowKey'><!-- --></a>
    <h3>RowKey</h3>
    <code>CHARACTER PROPERTY GET SET </code>
    <dl>
      <dd>Return page positioned to this key (i.e. resort request/ reopen ) <p> </dd>
      <dd>Typically used with TableRequestTypeEnum:Position </dd>
      <dd>
        <dl><!-- --></dl>
      </dd>
    </dl>
    <hr />
    <a name='property.TableName'><!-- --></a>
    <h3>TableName</h3>
    <code>CHARACTER PROPERTY GET </code>
    <dl>
      <dd>protected set - not changeable - provide with constructor <p> </dd>
      <dd>
        <dl><!-- --></dl>
      </dd>
    </dl>
    <hr />
    <a name='property.TableRequestType'><!-- --></a>
    <h3>TableRequestType</h3>
    <code><a href="../../../../OpenEdge/CommonInfrastructure/Common/ServiceMessage/TableRequestTypeEnum.cls.html" title="OpenEdge.CommonInfrastructure.Common.ServiceMessage.TableRequestTypeEnum" target="classFrame">TableRequestTypeEnum</a> PROPERTY GET SET </code>
    <dl>
      <dd>
        <dl><!-- --></dl>
      </dd>
    </dl>
    <hr />
				<A NAME="method_detail"><!-- --></A>
				<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
				<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
				<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
				<B>Method Detail</B></FONT></TH>
				</TR></TABLE>
				
    <a name='addsearch(character,character,openedge.lang.operatorenum,openedge.lang.string,openedge.lang.datatypeenum,openedge.lang.joinenum)'><!-- --></a>
    <h3>AddSearch</h3>
    <code>PUBLIC  VOID
      <b>AddSearch</b>(CHARACTER pcBufferName, CHARACTER pcFieldName, <a href="../../../../OpenEdge/Lang/OperatorEnum.cls.html" title="OpenEdge.Lang.OperatorEnum" target="classFrame">OperatorEnum</a> poOperator, <a href="../../../../OpenEdge/Lang/String.cls.html" title="OpenEdge.Lang.String" target="classFrame">String</a> poFieldValue, <a href="../../../../OpenEdge/Lang/DataTypeEnum.cls.html" title="OpenEdge.Lang.DataTypeEnum" target="classFrame">DataTypeEnum</a> poFieldType, <a href="../../../../OpenEdge/Lang/JoinEnum.cls.html" title="OpenEdge.Lang.JoinEnum" target="classFrame">JoinEnum</a> poJoinType)
    </code>
    <dl>
      <dd>Add search expression  (need to be kept separate from filter). <p> </dd>
      <dd>- Allthough this in theory could be any complex expression it normally only makes sense when the field(s) correspond(s) to the sort. - AddSearch can be refactored to have type-specific signatures, removing the need to pass a DataTypeEnum. </dd>
      <dd>
        <dl><!-- --></dl>
      </dd>
    </dl>
    <hr />
    <a name='buildsearchstring()'><!-- --></a>
    <h3>BuildSearchString</h3>
    <code>PUBLIC  LONGCHAR
      <b>BuildSearchString</b>()
    </code>
    <dl>
      <dd>returns the search expression applied to the BuildQueryString <p> </dd>
      <dd>
        <dl><!-- --></dl>
      </dd>
    </dl>
    <hr />
    <a name='getsearch(character,OUTPUT_character,OUTPUT_openedge.lang.operatorenum,OUTPUT_openedge.lang.string,OUTPUT_openedge.lang.datatypeenum,OUTPUT_openedge.lang.joinenum)'><!-- --></a>
    <h3>GetSearch</h3>
    <code>PUBLIC  VOID
      <b>GetSearch</b>(CHARACTER pcBufferName, OUTPUT CHARACTER pcFieldName, OUTPUT <a href="../../../../OpenEdge/Lang/OperatorEnum.cls.html" title="OpenEdge.Lang.OperatorEnum" target="classFrame">OperatorEnum</a> poOperator, OUTPUT <a href="../../../../OpenEdge/Lang/String.cls.html" title="OpenEdge.Lang.String" target="classFrame">String</a> pcFieldValue, OUTPUT <a href="../../../../OpenEdge/Lang/DataTypeEnum.cls.html" title="OpenEdge.Lang.DataTypeEnum" target="classFrame">DataTypeEnum</a> poFieldType, OUTPUT <a href="../../../../OpenEdge/Lang/JoinEnum.cls.html" title="OpenEdge.Lang.JoinEnum" target="classFrame">JoinEnum</a> poJoinType)
    </code>
    <dl>
      <dd>
        <dl><!-- --></dl>
      </dd>
    </dl>
    <hr />
  </body>
</html>